Alamofire 阅读

2017-11-12

Alamofire Swift 第一网络库

开头

Alamofire 是AFNetworking 的swift实现版本。相较于OC版本的AFNetwokring，swift简洁的语法和不再兼容connection方式，使得Alamofire的代码少了很多，同时Alamofire仍旧是swift平台上使用最多的移动端网络库。

代码结构

包含核心，特性，扩展，支持文件，对比兄弟OC的AFNetwokring可以说瘦身不少。

核心文件

根据文件名，不难看出每个文件的作用。主要包含了网络库的基本内容。

request

request是处理请求的部分。包含了三个协议protocol

requestAdapter 需要协议实现者实现将一个URLRequest处理成合适的方式
RequestRetrier 需要协议实现者实现是否需要将一个Request在完成回掉完成后发起重试
TaskConvertible 需要协议是实现者实现将输入的URLSession,输出URLSessionTask

之后实现了一个基类Request，对于网络请求的抽象

Request是对所有网络请求类型的抽象，其中包含一下类型

-w652

在初始化方法中，根据requestTask的类型，调用不同的taskDelegate 的初始化方法，初始化taskdelegate。在taskdelegate 中的 queue 中添加 operation

1	self.endTime = CFAbsoluteTimeGetCurrent()

下面的方法中大量使用@discardableResult来标记。@discardableResult的作用是告诉调用者可以忽略返回值。

authenticate 方法提供了 HTTP 基本的身份校验。默认

这两个方法都是返回 Self 的。对 Self 开始并不清楚，以下这段解释是我看的说的比较明白的

而在声明接口时，我们希望在接口中使用的类型就是实现这个接口本身的类型的话，就需要使用 Self 进行指代。

下面的三个方法实现了：恢复，挂起，取消

注意到，每次都用一个临时变量 task 去获取本地 task，这点很有意思。如果获取不到，就直接退出了，说明 task 已经结束或者不存在

接下来是实现了两个extension，都遵循CustomStringConvertible协议，自定义了description和debugDescription方法。其中description方法输出基本的请求信息，debugDescription则输出curl 方法

DataRequest 是 Request 的子类，用来管理URLSessionDataTask

上述方法实现了TaskConvertible协议，尝试将自身的 urlRequest 转义，然后同步到 queue 中执行。

这里有个知识点： as! as? as

as 是向上转型，as!和 as?都是向下转型

as!和 as?不同的是：

as!如果转型失败会抛出 runtime 错误

as?转型返回可选类型，需要用户自行解包。

response

response中前两个structs,分别为DefaultDataResponse和DataResponse，都实现了存储upload task的data存储。两者的区别是，DataResponse存储的是序列化后的data，DefaultDataResponse存储的是未序列化的data。

struct DefaultDownloadResponse实现的未序列化的download request的返回data。DownloadResponse存储的是序列化的download request的data。

对应的都实现了相关的extension，分别实现了CustomStringConvertible和CustomDebugStringConvertible两个协议。

其中，DataResponse和DownloadResponse中都有个result属性，这个属性也是Alamofire定义的。

Result

Result是一个enum枚举类型,分别有.success和.failure两个枚举值，以及关联值Value和Error。

值得注意的是，result 和 response一样，都通过 extension 实现了 map、flatMap 方法。提供这两个方法可以让外部通过闭包的形式对result进行处理

TaskDelegate

TaskDelegate是负责所有代理回调和处理添加到任务执行队列任务的地方。

注意到属性task里面有几个知识点

var task: URLSessionTask? {
        set {
            taskLock.lock(); defer { taskLock.unlock() }
            _task = newValue
        }
        get {
            taskLock.lock(); defer { taskLock.unlock() }
            return _task
        }
    }

首先set/get 时候用 Lock 进行加锁，原因是防止 task 在读写的时候被其他线程进行了改动。其次，使用了 defer 字段包括了解锁部分的代码。defer 的作用是申明一段代码块无论如何都会执行。

A defer statement defers execution until the current scope is exited. This statement consists of the defer keyword and the statements to be executed later. The deferred statements may not contain any code that would transfer control out of the statements, such as a break or a return statement, or by throwing an error. Deferred actions are executed in the reverse of the order that they’re written in your source code. That is, the code in the first defer statement executes last, the code in the second defer statement executes second to last, and so on. The last defer statement in source code order executes first.

taskDelegate主要执行URLSession的回掉方法。

SessionDelegate

SessionDelegate是对Session delegate回掉的封装。主要的属性都是一个回调闭包。

其中有三个个属性：retrier和sessionManager，requests。

retrier是一个RequestRetrier类型的属性。

sessionManager是SessionManager类型的属性

requests是[Int:Request]类型的字典

重写了responds方法，对不同系统不同selector做出判断。

SessionDelegate 通过 extension声明遵守了 URLSessionDelegate ， URLSessionTaskDelegate，URLSessionDataDelegate,URLSessionDownloadDelegate,URLSessionStreamDelegate protocol，因此实现了对应的方法

SessionManager

sessionManager 可以说是 Alamofire 里面最重要的一部分了，主要负责管理 request 和其他在 URLSessionR下面的内容

对于 sessionManager，Alamofire 鼓励有且只有一个 sessionManager，除非如同 chrome safari这些浏览器一样需要有类似隐私模式

对于创建一个 queue，可以用以下的方式

1	DispatchQueue(label: "org.alamofire.session-manager." + UUID().uuidString)

这样在堆栈跟踪的时候可以方便追溯。

在Sessionmanager里面大量使用了闭包求值的方式

let alamofireVersion: String = {
                   guard
                       let afInfo = Bundle(for: SessionManager.self).infoDictionary,
                       let build = afInfo["CFBundleShortVersionString"]
                   else { return "Unknown" }

                   return "Alamofire/\(build)"
               }()

这种方式很有意思，用闭包初始化相较于普通属性初始化的好处在于可以更简单的初始化属性，特别是对于属性开始时需要一个默认的值。

但是使用闭包初始化的时候要注意，因为在闭包内部，有些值是不安全的

let helloWorldLbl:UILabel = {
    let lbl = UILabel()
    lbl.text = self.someFunctionToDetermineText() //Compiler error
    lbl.font = UIFont.preferredFontForTextStyle(UIFontTextStyleBody)
    lbl.textColor = self.myAppTheme.textColor() //Another error
    lbl.textAlignment = .Center
    return lbl
}()

代码中的self就是不安全的，因为self可能没有初始化，同时self可能会引起循环调用。

其他的主要是URLSession的调用方法封装。

AFError

AFError继承了Error，是Alamofire对error的封装。

没有太特别的东西，不过对于业务已经逻辑错误的封装，有很多可以学习的地方。

Notifications

封装了四种通知类型，提供一个扩展来提供一个key作为notification的userinfo的key

ParameterEncoding

ParameterEncoding也是整个工程中非常重要的一个环节。我们知道在发送httpRequest的时候需要根据header中的content-type来确定我们的请求参数用什么样的方式去encode编码。
ParameterEncoding就是用来对参数做encode的。

ParameterEncoding中总共提供了三个struct，对应URLEncoding,JSONEncoding，PropertyEncoding。每个struct都遵循ParameterEncodingprotocol，所以他们都需要实现对应的encoding方法

在对字符串的处理上有些小技巧很值得借鉴，后面可以单独抽出来学习。

MultipartFormData

MultipartFormData是为upload中multipart/form-data类型提供encode方法。相比较ParameterEncoding不同，需要一些特殊处理

Constructs multipart/form-data for uploads within an HTTP or HTTPS body. There are currently two ways to encode multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the
data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.

这部分展开了可以学习的太多了。这里主要了解是用来对上传encode就可以了。

NetworkReachabilityManager

NetworkReachabilityManager是Alamofire实现的网络状态管理工具方法。

通过SCNetworkReachabilitySetCallback回调监听系统网络变化。

let callbackEnabled = SCNetworkReachabilitySetCallback(
            reachability,
            { (_, flags, info) in
                let reachability = Unmanaged<NetworkReachabilityManager>.fromOpaque(info!).takeUnretainedValue()
                reachability.notifyListener(flags)
            },
            &context
        )

以上方法将取得一个NetworkReachabilityManager实例，调用notifyListener方法将flags传递给回调方法。

在NetworkReachabilityManager最重要的一点就是学习如何在swift中管理C指针和C对象。

在convenience init?中，我们看到

guard let reachability = withUnsafePointer(to: &address, { pointer in
            return pointer.withMemoryRebound(to: sockaddr.self, capacity: MemoryLayout<sockaddr>.size) {
                return SCNetworkReachabilityCreateWithAddress(nil, $0)
            }
        }) else { return nil }

这里将address作为指针传入，通过closure返回一个指针实例。pointer.withMemoryRebound是一次性绑定，将指针指定为指定的type.

ResponseSerialization

ResponseSerialization中定义和实现了response的序列化方法。

ServerTrustPolicy

ServerTrustPolicy实现的是服务器认证管理。

Timeline

Timeline用来管理请求生命周期中的时间节点。

validation

validation用来管理认证结果